<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>lib.scripting.QtDialog</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;lib ::
        <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
        Class&nbsp;QtDialog
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="lib.scripting.QtDialog-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class QtDialog</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog">source&nbsp;code</a></span></p>
<p>Provides a simple interface for the display of some basic dialogs to 
  collect information from the user.</p>
  <p>This version uses KDialog to integrate well with KDE. To pass 
  additional arguments to KDialog that are not specifically handled, use 
  keyword arguments. For example, to pass the --geometry argument to 
  KDialog to specify the desired size of the dialog, pass 
  <code>geometry=&quot;700x400&quot;</code> as one of the parameters. All 
  keyword arguments must be given as strings.</p>
  <p>A note on exit codes: an exit code of 0 indicates that the user 
  clicked OK.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_run_kdialog"></a><span class="summary-sig-name">_run_kdialog</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>,
        <span class="summary-sig-arg">args</span>,
        <span class="summary-sig-arg">kwargs</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog._run_kdialog">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#info_dialog" class="summary-sig-name">info_dialog</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Information</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show an information dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.info_dialog">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#input_dialog" class="summary-sig-name">input_dialog</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show an input dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.input_dialog">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#password_dialog" class="summary-sig-name">password_dialog</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a password input dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.password_dialog">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#combo_menu" class="summary-sig-name">combo_menu</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">options</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a combobox menu</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.combo_menu">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#list_menu" class="summary-sig-name">list_menu</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">options</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a single-selection list menu</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#list_menu_multi" class="summary-sig-name">list_menu_multi</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">options</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">defaults</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a multiple-selection list menu</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu_multi">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#open_file" class="summary-sig-name">open_file</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Open File</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">initialDir</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">fileTypes</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show an Open File dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.open_file">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#save_file" class="summary-sig-name">save_file</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Save As</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">initialDir</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">fileTypes</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a Save As dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.save_file">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#choose_directory" class="summary-sig-name">choose_directory</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Directory</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">initialDir</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a Directory Chooser dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_directory">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#choose_colour" class="summary-sig-name">choose_colour</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Colour</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a Colour Chooser dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_colour">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>tuple(int, str)</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#calendar" class="summary-sig-name">calendar</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a date</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">%Y-%m-%d</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">date</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">today</code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">**kwargs</span>)</span><br />
      Show a calendar dialog</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.calendar">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="info_dialog"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">info_dialog</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Information</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.info_dialog">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show an information dialog</p>
  <p>Usage: <code>dialog.info_dialog(title=&quot;Information&quot;, 
  message=&quot;&quot;, **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>message</code></strong> - message displayed in the dialog</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and user input</dd>
  </dl>
</td></tr></table>
</div>
<a name="input_dialog"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">input_dialog</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">default</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.input_dialog">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show an input dialog</p>
  <p>Usage: <code>dialog.input_dialog(title=&quot;Enter a value&quot;, 
  message=&quot;Enter a value&quot;, default=&quot;&quot;, 
  **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>message</code></strong> - message displayed above the input box</li>
        <li><strong class="pname"><code>default</code></strong> - default value for the input box</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and user input</dd>
  </dl>
</td></tr></table>
</div>
<a name="password_dialog"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">password_dialog</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.password_dialog">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a password input dialog</p>
  <p>Usage: <code>dialog.password_dialog(title=&quot;Enter password&quot;, 
  message=&quot;Enter password&quot;, **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>message</code></strong> - message displayed above the password input box</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and user input</dd>
  </dl>
</td></tr></table>
</div>
<a name="combo_menu"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">combo_menu</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">options</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.combo_menu">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a combobox menu</p>
  <p>Usage: <code>dialog.combo_menu(options, title=&quot;Choose an 
  option&quot;, message=&quot;Choose an option&quot;, **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>message</code></strong> - message displayed above the combobox</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and user choice</dd>
  </dl>
</td></tr></table>
</div>
<a name="list_menu"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">options</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">default</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a single-selection list menu</p>
  <p>Usage: <code>dialog.list_menu(options, title=&quot;Choose a 
  value&quot;, message=&quot;Choose a value&quot;, default=None, 
  **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>message</code></strong> - message displayed above the list</li>
        <li><strong class="pname"><code>default</code></strong> - default value to be selected</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and user choice</dd>
  </dl>
</td></tr></table>
</div>
<a name="list_menu_multi"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu_multi</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">options</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">defaults</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu_multi">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a multiple-selection list menu</p>
  <p>Usage: <code>dialog.list_menu_multi(options, title=&quot;Choose one or
  more values&quot;, message=&quot;Choose one or more values&quot;, 
  defaults=[], **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>message</code></strong> - message displayed above the list</li>
        <li><strong class="pname"><code>defaults</code></strong> - list of default values to be selected</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and user choice</dd>
  </dl>
</td></tr></table>
</div>
<a name="open_file"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">open_file</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Open File</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">initialDir</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">fileTypes</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.open_file">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show an Open File dialog</p>
  <p>Usage: <code>dialog.open_file(title=&quot;Open File&quot;, 
  initialDir=&quot;~&quot;, fileTypes=&quot;*|All Files&quot;, 
  rememberAs=None, **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>initialDir</code></strong> - starting directory for the file dialog</li>
        <li><strong class="pname"><code>fileTypes</code></strong> - file type filter expression</li>
        <li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last 
          used path next time</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and file path</dd>
  </dl>
</td></tr></table>
</div>
<a name="save_file"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save_file</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Save As</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">initialDir</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">fileTypes</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.save_file">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a Save As dialog</p>
  <p>Usage: <code>dialog.save_file(title=&quot;Save As&quot;, 
  initialDir=&quot;~&quot;, fileTypes=&quot;*|All Files&quot;, 
  rememberAs=None, **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>initialDir</code></strong> - starting directory for the file dialog</li>
        <li><strong class="pname"><code>fileTypes</code></strong> - file type filter expression</li>
        <li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last 
          used path next time</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and file path</dd>
  </dl>
</td></tr></table>
</div>
<a name="choose_directory"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">choose_directory</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Directory</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">initialDir</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_directory">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a Directory Chooser dialog</p>
  <p>Usage: <code>dialog.choose_directory(title=&quot;Select 
  Directory&quot;, initialDir=&quot;~&quot;, rememberAs=None, 
  **kwargs)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>initialDir</code></strong> - starting directory for the directory chooser dialog</li>
        <li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last 
          used path next time</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and chosen path</dd>
  </dl>
</td></tr></table>
</div>
<a name="choose_colour"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">choose_colour</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Colour</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_colour">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a Colour Chooser dialog</p>
  <p>Usage: <code>dialog.choose_colour(title=&quot;Select 
  Colour&quot;)</code></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and colour</dd>
  </dl>
</td></tr></table>
</div>
<a name="calendar"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">calendar</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a date</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">%Y-%m-%d</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">date</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">today</code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">**kwargs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.calendar">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Show a calendar dialog</p>
  <p>Usage: <code>dialog.calendar_dialog(title=&quot;Choose a date&quot;, 
  format=&quot;%Y-%m-%d&quot;, date=&quot;YYYY-MM-DD&quot;, 
  **kwargs)</code></p>
  <p>Note: the format and date parameters are not currently used</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
        <li><strong class="pname"><code>format</code></strong> - format of date to be returned</li>
        <li><strong class="pname"><code>date</code></strong> - initial date as YYYY-MM-DD, otherwise today</li>
    </ul></dd>
    <dt>Returns: <code>tuple(int, str)</code></dt>
        <dd>a tuple containing the exit code and date</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
